Extract NLP-based Query Results

{ extractNlpQueryResult }

Runs an Natural Language query against the specified data source and extracts the query result data into the specified format (CSV, JSON, XML).

Method

/API2/query/extractNlpQueryResult

  • API Section: /API2/query
  • API Version: 2.0
  • From Release: 2023.00
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
    • Domain Admin
    • Pro
    • Analyst
    • Viewer
    • Basic
    • Input Parameters

    Name

    data

    Object Type

    NlpQueryExportData

    Description

    The query export object used to specify how to extract nlp query results.

    Output Response

    Successful Result Code

    200

    Response Type

    string

    Description of Response Type

    successful operation

    Notes

    Queries are extracted in flattened tabular format – and do not represent the cartesian placement of the data.